/*******************************************************************************
 * Copyright (C) Marvell International Ltd. and its affiliates
 *
 * This software file (the "File") is owned and distributed by Marvell
 * International Ltd. and/or its affiliates ("Marvell") under the following
 * alternative licensing terms.  Once you have made an election to distribute the
 * File under one of the following license alternatives, please (i) delete this
 * introductory statement regarding license alternatives, (ii) delete the three
 * license alternatives that you have not elected to use and (iii) preserve the
 * Marvell copyright notice above.
 *
 ********************************************************************************
 * Marvell Commercial License Option
 *
 * If you received this File from Marvell and you have entered into a commercial
 * license agreement (a "Commercial License") with Marvell, the File is licensed
 * to you under the terms of the applicable Commercial License.
 *
 ********************************************************************************
 * Marvell GPL License Option
 *
 * If you received this File from Marvell, you may opt to use, redistribute and/or
 * modify this File in accordance with the terms and conditions of the General
 * Public License Version 2, June 1991 (the "GPL License"), a copy of which is
 * available along with the File in the license.txt file or by writing to the Free
 * Software Foundation, Inc., or on the worldwide web at http://www.gnu.org/licenses/gpl.txt.
 *
 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE ARE EXPRESSLY
 * DISCLAIMED.  The GPL License provides additional details about this warranty
 * disclaimer.
 *
 ********************************************************************************
 * Marvell GNU General Public License FreeRTOS Exception
 *
 * If you received this File from Marvell, you may opt to use, redistribute and/or
 * modify this File in accordance with the terms and conditions of the Lesser
 * General Public License Version 2.1 plus the following FreeRTOS exception.
 * An independent module is a module which is not derived from or based on
 * FreeRTOS.
 * Clause 1:
 * Linking FreeRTOS statically or dynamically with other modules is making a
 * combined work based on FreeRTOS. Thus, the terms and conditions of the GNU
 * General Public License cover the whole combination.
 * As a special exception, the copyright holder of FreeRTOS gives you permission
 * to link FreeRTOS with independent modules that communicate with FreeRTOS solely
 * through the FreeRTOS API interface, regardless of the license terms of these
 * independent modules, and to copy and distribute the resulting combined work
 * under terms of your choice, provided that:
 * 1. Every copy of the combined work is accompanied by a written statement that
 * details to the recipient the version of FreeRTOS used and an offer by yourself
 * to provide the FreeRTOS source code (including any modifications you may have
 * made) should the recipient request it.
 * 2. The combined work is not itself an RTOS, scheduler, kernel or related
 * product.
 * 3. The independent modules add significant and primary functionality to
 * FreeRTOS and do not merely extend the existing functionality already present in
 * FreeRTOS.
 * Clause 2:
 * FreeRTOS may not be used for any competitive or comparative purpose, including
 * the publication of any form of run time or compile time metric, without the
 * express permission of Real Time Engineers Ltd. (this is the norm within the
 * industry and is intended to ensure information accuracy).
 *
 ********************************************************************************
 * Marvell BSD License Option
 *
 * If you received this File from Marvell, you may opt to use, redistribute and/or
 * modify this File under the following licensing terms.
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 *	* Redistributions of source code must retain the above copyright notice,
 *	  this list of conditions and the following disclaimer.
 *
 *	* Redistributions in binary form must reproduce the above copyright
 *	  notice, this list of conditions and the following disclaimer in the
 *	  documentation and/or other materials provided with the distribution.
 *
 *	* Neither the name of Marvell nor the names of its contributors may be
 *	  used to endorse or promote products derived from this software without
 *	  specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *******************************************************************************/

/**
 * @file PP2_plat.h
 *
 * Packet Processor SDK platform hardware information
 *
 * Used internally and/or as an exportable header to
 * an application or to an external implementation
 *
 */
#ifndef _PP2_PLAT_H_
#define _PP2_PLAT_H_

/******************************************************************************/
/*                 Hardware Resources per Platform                            */

/* Platform specific absolute hardware values.
 *
 * NOTE: These should be treated as read-only primitives
 * and are exported here for informational reasons
 *
 * The real hardware configuration values on which PPDK and
 * run-time clients shall work will be derived from these
 * after platform and resource offsets have been established
 */


/* Absolute number of hardware ports */
#define PP2_NUM_PORTS                (4)
/* Absolute number of hardware register spaces */
#define PP2_NUM_REGSPACES            (9)
/* Absolute number of hardware packet processors */
#define PP2_MAX_NUM_PACKPROCS        (8)

/* Number of RXQs per port */
#define PP2_HW_PORT_NUM_RXQS         (32)
/* Number of TXQs per port */
#define PP2_HW_PORT_NUM_TXQS         (8)

#define PP2_LOOPBACK_PORT             (3)

#define LPBK_PORT(x)			((x)->id == PP2_LOOPBACK_PORT)
#define NOT_LPBK_PORT(x)		(!((x)->id == PP2_LOOPBACK_PORT))


/******************************************************************************/
/*    Hardware Resources Offsets(reserved to OS/slow path) per Platform       */

/******************************************************************************/
/*                  Resources configured and used by PPDK                     */

/* Size of a CPU space (slot) */
#define PP2_REGSPACE_SIZE     (0x10000)
/* Address size to skip when mapping packet processor register space */
/* #define PP2_SLOT_OFS_ADDR     (PP2_OFS_REGSPACES * PP2_REGSPACE_SIZE) */
/* Default register space index used for initializing
 * common hardware parts
 */
#define PP2_DEFAULT_REGSPACE  (0)

/* Number of RXQs per port - configured */
#define PP2_PORT_NUM_RXQS         (1)
#if (PP2_PORT_NUM_RXQS > PP2_HW_PORT_NUM_RXQS)
#error "number of configured RxQs cannot exceed available RxQs";
#endif
/* Number of TXQs per port - configured */
#define PP2_PORT_NUM_TXQS         (1)
#if (PP2_PORT_NUM_TXQS > PP2_HW_PORT_NUM_TXQS)
#error "number of configured TxQs cannot exceed available TxQs";
#endif

/* 64bytes cache line - arm64 spec */
#define L1_CACHE_LINE_BYTES      BIT(6)

/* Packet offset always used by HW at the beginng of packets.
 * This is valid for the first buffer of the packet,
 * all other buffers have a fixed offset = 32bytes
 */
#define PP2_PACKET_DEF_OFFSET     (L1_CACHE_LINE_BYTES)
#define PP2_MAX_PACKET_OFFSET     (7*32)
#define PP2_BUFFER_OFFSET_GRAN    (32)


/* 32bytes always used by HW, found  at the beginning of buffers
 * It is also part of the packet offset(PP2_PACKET_OFFSET), first buffer
 */
#define PP2_BUFFER_OFFSET         (32)


#endif /* _PP2_PLAT_H_ */
